/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.curator.framework.recipes.locks;

import java.util.concurrent.TimeUnit;

public interface InterProcessLock
{
    /**
     * 获取锁，堵塞直到得到锁， 任何调用acquire获取锁必须要调用release()进行释放
     */
    public void acquire() throws Exception;

    /**
     * 获取锁，堵塞直到得到锁或者到指定的时间失效， 任何调用acquire获取锁必须要调用release()进行释放
     */
    public boolean acquire(long time, TimeUnit unit) throws Exception;

    /**
     * 释放锁
     * @throws Exception zk错误，中断，当前现在不再拥有锁
     */
    public void release() throws Exception;

    /**
     * 如果锁被当前JVM内线程获取则返回true
     * @return
     */
    boolean isAcquiredInThisProcess();
}
